home *** CD-ROM | disk | FTP | other *** search
/ Inside Mac Games Volume 4 #8 / IMG 39 Aug 1996.iso / More Goodies / More For Your Game / Marathon 2 / MaraOS ƒ / ReadMe < prev    next >
Text File  |  1995-12-05  |  14KB  |  163 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9. MaraOS v1.0.1 - a Marathon module manager.
  10. © 1995 Harry Hahn
  11. <mailto:hhahn@calshp.cals.wisc.edu>
  12. <http://apollo.ahabs.wisc.edu/Individuals/Students/Hahn/MarathonStuff.html>
  13. (where the latest versions and documentation are kept).
  14.  
  15. About MaraOS
  16. MaraOS, formerly called Marathon Runner,  is an application that makes it easier to manage all the different Marathon accessory files (modules) you might have accumulated. The usual way to do this involves a lot of copying, moving, renaming, and forgetting. I wrote MaraOS to make this process somewhat simpler- it moves files to their proper place and renames them, freeing you to organize and name modules as you see fit. By keeping track of names and locations for you, MaraOS allows you to get on with the killing with the minimum of fuss.
  17.  
  18. It does this by searching for modules within a certain folder and presenting a dialog with popup menus that allow you to more easily select the different modules you want to use. It tracks the following modules: Marathon Preferences, Map, Music, Physics Model, Shapes, Sounds, and different Marathon applications (such as ones whose terminal resources are patched). It then moves modules to their appropriate locations, renames them, and launches the selected Marathon application.
  19.  
  20. Basically, it's a Startup/Extension Manager kind of program, but  for Marathon.
  21.  
  22. Using MaraOS
  23. To use MaraOS, place it in the same folder as the Marathon application.  Place all modules you wish to select from within this folder. MaraOS will then search this folder and all folders within for modules. You can organize your modules any way you please, but before running MaraOS for the first time, heed the following caveats:
  24.  
  25. - give all your modules names other than the standard Bungie names (ie no map files named "Map"). 
  26. - make sure all modules have unique names (ie 2 files named "Cool Map" = bad).
  27. - make sure you don't have folders with the standard Bungie names (ie use "Shapes folder" instead of "Shapes")
  28. - Don't forget to rename and move the Marathon Preferences file from the Preferences Folder to within Marathon's folder!!!
  29.  
  30. If MaraOS encounters a exception to the guidelines above, you will most likely get an error alert prompting you to move or rename certain files. See the troubleshooting document for more information.
  31.  
  32. Now run MaraOS. After MaraOS searches for modules, you'll be presented with a dialog window with popups from which to choose them. Make your selections and launch Marathon by either clicking on the "Launch Marathon" button or selecting "Launch Marathon" from the File menu.
  33.  
  34. The selected Marathon application will then launch using the selected modules. When Marathon quits, MaraOS will move the module files back to their original locations and you may either quit by selecting "Quit" from the File menu (command-Q) or repeat the selection/launch process.
  35.  
  36. Using Sets
  37. You can link modules by creating sets. MaraOS tracks at least one set, called "Standard". You can create new sets and delete existing ones by selecting "Edit Sets…" from the File menu (command-E). You will then be presented with a dialog window listing all current sets.
  38.  
  39. Clicking on the "New…" button will bring up yet another dialog window asking you to name your new set. Keep set names to less than 64 characters. The new set will configure itself with the current module selections.
  40.  
  41. Selecting a set within the set editing dialog and clicking on the "Delete" button will delete that set. You cannot delete the "Standard" set.
  42.  
  43. Click on the "OK" button or double-click on a set name to exit the set editing dialog. Double-clicking on a set name will select that set as the current one displayed in the main dialog window.
  44.  
  45. To link modules to a set, select the set in the "Sets" popup menu and then select the modules you wish to link to that set.
  46.  
  47. Using Preferences
  48. In addition to moving files and launching Marathon, MaraOS can perform additional actions to enhance your killing experience. These options are available through the "Preferences…" item in the "File" menu.
  49.  
  50. Quit other apps - If this option is selected, MaraOS will attempt to quit all open applications and desk accessories before launcing Marathon. If an application or desk accessory has a document open that needs to be saved, that app will be brought to the foreground and you will be given a chance to save your document. Regardless of whether you quit the application or cancel, MaraOS will continue on it's merry way and may leave applications open.
  51.  
  52. Also, keep in mind that Macintosh applications need contiguous blocks of memory to run in. Although quitting applications may free up memory, fragmenting due to quitting applications in a different order than they were launched can create "low memory" situations. In these cases, it's best to quit all your applications before running MaraOS.
  53.  
  54. Quit file sharing- If this option is selected, MaraOS will turn file sharing off if it is running. When you quit MaraOS, it will turn it back on. Please read the section on known bugs below for additional info on this feature.
  55.  
  56. Quit the Finder- If this option is selected, MaraOS will quit the Finder. Be aware that quitting the Finder can have unexpected consequences as its presence may be expected in certain circumstances.
  57.  
  58. MaraOS can not kill processes other than the one's mentioned above. Other, background-only processes (daemons) will continue to run.
  59.  
  60. Move on quit- You can also have MaraOS move a selected set into position when you quit. This can be useful if others play Marathon on your computer and do not use MaraOS, or you need to generate a preference file with a different serial number for Marathon. To use this feature, click the checkbox so that it is on and then select a set from the adjacent popupmenu. That set will be moved into position once you quit MaraOS. If the "<current>" item is selected, the set displayed in the main dialog window will be moved.
  61.  
  62. Technical Notes
  63. MaraOS is a bit slower to start up than Marathon Runner was (making "Runner" something of  a misnomer). This is a consequence of the new file searching algorithm- a trade off of speed for flexibility in organization. However, MaraOS makes up for this lost time by not quitting after launch, so you have the endure the initialization only once. I mostly play NetMarathon and I'm usually the Gathering Dude- I end up switching maps quite frequently. The way I wrote MaraOS reflects this usage, minimizing the downtime between games as I switch modules.
  64.  
  65. If the lag really bothers you, remove extraneous files from the Marathon folder (ReadMes, infrequently used modules, etc.). 
  66.  
  67. The app quitting feature works by killing all processes with types of 'APPL' or 'dfil', in other words regular apps and desk accessories. I've decided that killing all processes would be bad, but if there's interest, I may include a option for this.
  68.  
  69. The progress bar works by storing the number of progress steps it took at startup. The first time you run this version, the progress bar might be "off" since it has to guess. However, successive runs should provide a better indication of progress, unless gross changes have been made to the directory wherein MaraOS resides.
  70.  
  71. I've been slack at making sure a lot of the calls I make are available (gestalt? Who needs it.). This means that MaraOS will probably make your computer burst in flames if you're running System 6. Since Marathon won't run under System 6, I haven't sweated it- if your system software will run Marathon, it should run MaraOS as well.
  72.  
  73. Sometimes, the OK button isn't "defaulted" (outlined and linked to the <return> & <enter> keys) in certain dialogs. The culprits are button-modifying extensions- Godot's World in particular fails to accept the OK button as default in the Sets dialog. Either remove those extensions (yeah, right), or reach for your mouse.
  74.  
  75. The file sharing quitting feature has the following "bug" : if someone is connected to your machine at the time that MaraOS tries to quit file sharing, erratic behavior can result. Most often, file sharing may not be quit when Marathon launches and/or may not relaunch when MaraOS quits. If the "quit Finder" option is also enabled, even weirder things can happen, such as Marathon switching to the background (didn't know that could happen ;)).
  76.  
  77. None of the items in the Edit menu do anything.
  78.  
  79. While other similar applications (Marathon Mystifier and Marathon Master for example) accomplish the same goal as MaraOS by modifiying Marathon to look for a particular module, I've opted to move files to accomodate Marathon. I do this out of my own reservations at modifying the Marathon application in any way. A downside to this is that file tracking is a bit more complicated and can sometimes get confused. If this happens, move and rename files manually as appropriate, and if that doesn't work, throw out the MaraOS Preferences file.
  80.  
  81. As you may have noticed by the version number, MaraOS is now in final release. Thanks go to the many people who've tried it, submitted their comments and suggestions, and helped me track down bugs. It's been a bumpy ride but since I was learning as I went along, I hope you can understand :).
  82.  
  83. I've put it all the features that I envisioned in an ideal Marathon file manager (well, except for the resolution-switching, which is apparently really hairy. Anyone have some code?), but if there's a feature you'd like to see, please let me know. Sometimes I need to bash my head repeatedly against the wall.
  84.  
  85. Legal Stuff
  86. MaraOS is freeware, my way of giving back to the Marathon community for all the cool things that have come out of it. All I ask is that you consider dropping me an e-mail to tell me what you think, even if it is only to tell me how utterly boring and dry the ReadMe is.
  87.  
  88. While MaraOS is freeware, it is not public domain and I retain all rights. It may be freely distributed but please do not distribute modified copies and include the ReadMe and Troubleshooting documents. Also, please do not include MaraOS in a software bundle  without prior permission.
  89.  
  90. Thanks to
  91. Scott Johnson  - for the original idea and creative input
  92. Michael Leetmaa - for technical assistance
  93. Guillaume Fortin (author of Marathon Mystifier) - for technical discussion
  94. Nathan Federici - for the Copland-style folder icon
  95. Jim Luther of Apple Computer- for MoreFiles, saving me (and consequently the world) from writing my  own copying routines.
  96. Eddy J. Gurney- for his progress bar cdef.
  97. All the kind folks at c.s.m.programmer.help - for never letting my stupid questions go unanswered
  98. All the kids in the AHABS and Chemistry zones here at the University of Wisconsin - for providing me with my daily Marathon fix (yes, addiction is an ugly thing)
  99.  
  100. Version History
  101. 1.0.1
  102.     - Released 5 December 1995
  103.     - Put in a check to make sure LaunchApplication worked. Please see the Troubleshooting document for details.
  104. 1.0
  105.     - Released 9 November
  106.     - Bug whereby MaraOS wasn't accepting AppleEvents fixed (most notably the "quit" event).
  107.     - Quits other apps and file sharing as well as Finder on request (what a b*tch. Should work much better now.)
  108.     - "Move on quit" revamped so a chosen set can be moved upon quit, independent of the set currently active.
  109.     - (drum roll, please) Progress bar (tah da!). Not perfectly accurate, but better than Apple's.
  110.     - Troubleshooting document added- don't know if it's gonna help.
  111. 1.0b
  112.     - Released 15 August
  113.     - Quits Finder on request
  114.     - "Move on quit" feature moved to preferences
  115.     - Fattening cosmetics added
  116. 1.0a3
  117.     -    Released 26 June
  118.     - Fixed error whereby MaraOS failed to move modules when on non-startup volume (thanks to Robert Fleming for patiently working through this with me)
  119.     - Saves window position
  120.     - Implemented app quitting (barely)
  121. 1.0a2
  122.     - Released 20 June 1995
  123.     - Added Move & Quit item to File menu
  124.     - Tweaked error alerts so that they are slightly (just slightly) more informative
  125.     - Gives error if duplicate module names are found
  126.     - Gives error if files with Bungie standard names are found
  127.     - Made Launch button "default" (<return> or <enter>)
  128. 1.0a1
  129.   - Released 8 June 1995
  130.     - Just about re-wrote the whole damn thing
  131.     - Changed name of application from Marathon Runner to MaraOS
  132.     - Changed appearance of popups- they were proliferating like rabbits
  133.     - Re-wrote module searching and tracking routines
  134.     - Control of application to launch (ie different versions of Marathon)
  135.     - Made dialog modeless. It was very hard. It took a long time.  It still doesn't work well.
  136.     - Implemented sets. It was very hard. It took a long time. I hope you like it.
  137.     - Splash screen eye candy as you wait for start up 
  138.     - Fixed bug where Prefs file wouldn't transfer if Marathon wasn't on startup volume (what a pain!)
  139. 1.0d5
  140.     - Released 18 April 1995
  141.     - Fixed bug where if module of wrong file type was found, menu building stopped prematurely
  142.     - Fixed chaos that resulted when a module had Bungie's blessed name within the module folder
  143.     - Added some checks for file renaming and moving calls
  144. 1.0d4
  145.     - Released 13 April 1995 (wee! 3rd one in less than 24 hours! What a fucking fiasco.)
  146.     - Hopefully fixed character restriction for file names in a manner suitable for PowerMacs
  147. 1.0d3
  148.     - Released 13 April 1995
  149.     - Fixed problem causing failure on PowerMacs
  150.     - Re-introduced module name character restriction bug as a result
  151. 1.0d2
  152.     - Released 13 April 1995
  153.     - Fixed STR# for Physics Model to "Physics Model" (not "Physics". Duh.)
  154.     - Revamped ALRTs (they're a little less cryptic)
  155.     - Changed format of preferences file- this will probably change every revision :-(
  156.     - Now filters folders for correct file types
  157.     - Put in "<none>" selection for Physics and Music
  158.     - Popups display last used modules upon open (i.e. defaults)
  159.     - Fixed menu building so files that have a "/" in them don't screw up the popups
  160.     - Ignores control of module types when no folder is present
  161. 1.0d1
  162.     - Released 6 April 1995
  163.